<!doctype html>
<html lang="zh-CN" data-theme="light">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width,initial-scale=1" />
    <meta name="generator" content="VuePress 2.0.0-rc.0" />
    <meta name="theme" content="VuePress Theme Hope 2.0.0-rc.4" />
    <style>
      html {
        background: var(--bg-color, #fff);
      }

      html[data-theme="dark"] {
        background: var(--bg-color, #1d1e1f);
      }

      body {
        background: var(--bg-color);
      }
    </style>
    <script>
      const userMode = localStorage.getItem("vuepress-theme-hope-scheme");
      const systemDarkMode =
        window.matchMedia &&
        window.matchMedia("(prefers-color-scheme: dark)").matches;

      if (userMode === "dark" || (userMode !== "light" && systemDarkMode)) {
        document.documentElement.setAttribute("data-theme", "dark");
      }
    </script>
    <meta property="og:url" content="https://kkbt.gitee.io/obcsapi-go/obcsapi-go/"><meta property="og:site_name" content="Obcsapi Docs"><meta property="og:title" content="项目主页"><meta property="og:type" content="website"><meta property="og:locale" content="zh-CN"><meta property="og:updated_time" content="2023-12-14T13:06:19.000Z"><meta property="article:author" content="恐咖兵糖"><meta property="article:modified_time" content="2023-12-14T13:06:19.000Z"><script type="application/ld+json">{"@context":"https://schema.org","@type":"WebPage","name":"项目主页"}</script><title>项目主页 | Obcsapi Docs</title><meta name="description" content="">
    <link rel="preload" href="/obcsapi-go/assets/style-9s-QIunb.css" as="style"><link rel="stylesheet" href="/obcsapi-go/assets/style-9s-QIunb.css">
    <link rel="modulepreload" href="/obcsapi-go/assets/app-Z7Ab_rlY.js"><link rel="modulepreload" href="/obcsapi-go/assets/index.html-4rjMgIHd.js"><link rel="modulepreload" href="/obcsapi-go/assets/plugin-vue_export-helper-x3n3nnut.js"><link rel="modulepreload" href="/obcsapi-go/assets/index.html-fdTDfnjr.js">
    <link rel="prefetch" href="/obcsapi-go/assets/sidebar.html-jB1xGYqI.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/index.html-Hvy2wwxp.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/faq.html-mKoAR3uM.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/python-version.html-vf0nybSU.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/segmenter.html-x2RHHlfq.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/1-概述.html-1Aget6eB.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/10-软件联动.html-EmF0bIbD.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/2-运行与部署.html-wLD5V9DU.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/3-配置说明.html-eL8YncYb.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/4-功能使用.html-ttgMb7u6.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/5-图床说明.html-A11QdaTg.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/6-通用接口.html-U5YT_B5f.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/7-前端说明.html-KybtBryq.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/8-指令模式.html-wXtGs56E.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/9-自定义脚本.html--n-mXSKu.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/97-缓存说明.html-eFwNZ08d.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/98-开发说明.html-ZfxJGNnf.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/99-更新记录.html-0TejNJ5M.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/404.html-4ErOMmFg.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/index.html-xXuAGb7e.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/sidebar.html-wGVg8F5h.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/index.html-ruH2hKFx.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/faq.html-zDuUwFZF.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/python-version.html-OJC-u2wE.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/segmenter.html-E2ACBYNW.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/1-概述.html-wPWQo3X2.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/10-软件联动.html-gT0uOX_3.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/2-运行与部署.html-DN2q0Bmm.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/3-配置说明.html-xRzMnhoq.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/4-功能使用.html-HA04khvf.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/5-图床说明.html-6nBjP0OC.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/6-通用接口.html-lklqyXKl.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/7-前端说明.html-EpAGTac3.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/8-指令模式.html-9WLBzs8Q.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/9-自定义脚本.html-Cpm0CPel.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/97-缓存说明.html-4cg_AhVz.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/98-开发说明.html-mSLqrr6J.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/99-更新记录.html-KOAe7ckg.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/404.html-yZnpEtqh.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/index.html-IdkU12pD.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/giscus-unEZQsJ0.js" as="script"><link rel="prefetch" href="/obcsapi-go/assets/photoswipe.esm-i2ohwMnJ.js" as="script">
  </head>
  <body>
    <div id="app"><!--[--><!--[--><!--[--><span tabindex="-1"></span><a href="#main-content" class="vp-skip-link sr-only">跳至主要內容</a><!--]--><!--[--><div class="theme-container no-sidebar"><!--[--><header id="navbar" class="vp-navbar"><div class="vp-navbar-start"><button type="button" class="vp-toggle-sidebar-button" title="Toggle Sidebar"><span class="icon"></span></button><!--[--><!----><!--]--><!--[--><a class="vp-link vp-brand vp-brand" href="/obcsapi-go/"><img class="vp-nav-logo" src="https://theme-hope-assets.vuejs.press/logo.svg" alt="Obcsapi Docs"><!----><span class="vp-site-name hide-in-pad">Obcsapi Docs</span></a><!--]--><!--[--><!----><!--]--></div><div class="vp-navbar-center"><!--[--><!----><!--]--><!--[--><nav class="vp-nav-links"><div class="nav-item hide-in-mobile"><a aria-label="项目主页" class="vp-link nav-link active nav-link active" href="/obcsapi-go/"><span class="font-icon icon fa-fw fa-sm fas fa-home" style=""></span>项目主页<!----></a></div><div class="nav-item hide-in-mobile"><a aria-label="Obcsapi 文档" class="vp-link nav-link nav-link" href="/obcsapi-go/md/"><span class="font-icon icon fa-fw fa-sm fas fa-laptop-code" style=""></span>Obcsapi 文档<!----></a></div><div class="nav-item hide-in-mobile"><a href="https://gitee.com/kkbt/obcsapi-go" rel="noopener noreferrer" target="_blank" aria-label="代码 Gitee" class="nav-link"><span class="font-icon icon fa-fw fa-sm fas fa-link" style=""></span>代码 Gitee<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span><!----></a></div><div class="nav-item hide-in-mobile"><a href="https://github.com/kkbt0/obcsapi-go" rel="noopener noreferrer" target="_blank" aria-label="代码 Github" class="nav-link"><span class="font-icon icon fa-fw fa-sm fas fa-link" style=""></span>代码 Github<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span><!----></a></div></nav><!--]--><!--[--><!----><!--]--></div><div class="vp-navbar-end"><!--[--><!----><!--]--><!--[--><!----><div class="nav-item vp-repo"><a class="vp-repo-link" href="https://gitee.com/kkbt/obcsapi-go" target="_blank" rel="noopener noreferrer" aria-label="Gitee"><svg xmlns="http://www.w3.org/2000/svg" class="icon gitee-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="gitee icon" style="width:1.25rem;height:1.25rem;vertical-align:middle;"><path d="M512 992C246.92 992 32 777.08 32 512S246.92 32 512 32s480 214.92 480 480-214.92 480-480 480zm242.97-533.34H482.39a23.7 23.7 0 0 0-23.7 23.7l-.03 59.28c0 13.08 10.59 23.7 23.7 23.7h165.96a23.7 23.7 0 0 1 23.7 23.7v11.85a71.1 71.1 0 0 1-71.1 71.1H375.71a23.7 23.7 0 0 1-23.7-23.7V423.11a71.1 71.1 0 0 1 71.1-71.1h331.8a23.7 23.7 0 0 0 23.7-23.7l.06-59.25a23.73 23.73 0 0 0-23.7-23.73H423.11a177.78 177.78 0 0 0-177.78 177.75v331.83c0 13.08 10.62 23.7 23.7 23.7h349.62a159.99 159.99 0 0 0 159.99-159.99V482.33a23.7 23.7 0 0 0-23.7-23.7z"></path></svg></a></div><div class="nav-item hide-in-mobile"><button type="button" id="appearance-switch"><svg xmlns="http://www.w3.org/2000/svg" class="icon auto-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="auto icon" style="display:block;"><path d="M512 992C246.92 992 32 777.08 32 512S246.92 32 512 32s480 214.92 480 480-214.92 480-480 480zm0-840c-198.78 0-360 161.22-360 360 0 198.84 161.22 360 360 360s360-161.16 360-360c0-198.78-161.22-360-360-360zm0 660V212c165.72 0 300 134.34 300 300 0 165.72-134.28 300-300 300z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="dark icon" style="display:none;"><path d="M524.8 938.667h-4.267a439.893 439.893 0 0 1-313.173-134.4 446.293 446.293 0 0 1-11.093-597.334A432.213 432.213 0 0 1 366.933 90.027a42.667 42.667 0 0 1 45.227 9.386 42.667 42.667 0 0 1 10.24 42.667 358.4 358.4 0 0 0 82.773 375.893 361.387 361.387 0 0 0 376.747 82.774 42.667 42.667 0 0 1 54.187 55.04 433.493 433.493 0 0 1-99.84 154.88 438.613 438.613 0 0 1-311.467 128z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="light icon" style="display:none;"><path d="M952 552h-80a40 40 0 0 1 0-80h80a40 40 0 0 1 0 80zM801.88 280.08a41 41 0 0 1-57.96-57.96l57.96-58a41.04 41.04 0 0 1 58 58l-58 57.96zM512 752a240 240 0 1 1 0-480 240 240 0 0 1 0 480zm0-560a40 40 0 0 1-40-40V72a40 40 0 0 1 80 0v80a40 40 0 0 1-40 40zm-289.88 88.08-58-57.96a41.04 41.04 0 0 1 58-58l57.96 58a41 41 0 0 1-57.96 57.96zM192 512a40 40 0 0 1-40 40H72a40 40 0 0 1 0-80h80a40 40 0 0 1 40 40zm30.12 231.92a41 41 0 0 1 57.96 57.96l-57.96 58a41.04 41.04 0 0 1-58-58l58-57.96zM512 832a40 40 0 0 1 40 40v80a40 40 0 0 1-80 0v-80a40 40 0 0 1 40-40zm289.88-88.08 58 57.96a41.04 41.04 0 0 1-58 58l-57.96-58a41 41 0 0 1 57.96-57.96z"></path></svg></button></div><!----><!--]--><!--[--><!----><!--]--><button type="button" class="vp-toggle-navbar-button" aria-label="Toggle Navbar" aria-expanded="false" aria-controls="nav-screen"><span><span class="vp-top"></span><span class="vp-middle"></span><span class="vp-bottom"></span></span></button></div></header><!----><!--]--><!----><div class="toggle-sidebar-wrapper"><span class="arrow start"></span></div><aside id="sidebar" class="vp-sidebar"><!--[--><!----><!--]--><ul class="vp-sidebar-links"></ul><!--[--><!----><!--]--></aside><!--[--><main id="main-content" class="vp-project-home" aria-labelledby="main-title"><!----><header class="vp-hero-info-wrapper"><!--[--><div class="vp-hero-mask light" style="background-image:url(https://theme-hope-assets.vuejs.press/bg/6-light.svg);background-attachment:fixed;"></div><div class="vp-hero-mask dark" style="background-image:url(https://theme-hope-assets.vuejs.press/bg/6-dark.svg);background-attachment:fixed;"></div><!--]--><div class="vp-hero-info"><!--[--><img class="vp-hero-image" style="" src="/obcsapi-go/logo.svg" alt="Obcsapi"><!--]--><div class="vp-hero-infos"><h1 id="main-title">Obcsapi</h1><p id="main-description">Obsidian 云存储 API</p><p class="vp-hero-actions"><a aria-label="文档" class="vp-link nav-link vp-hero-action primary nav-link vp-hero-action primary" href="./md/"><!--[--><span class="font-icon icon fa-fw fa-sm fas fa-lightbulb" style=""></span><!--]-->文档<!----></a><a href="https://gitee.com/kkbt/obcsapi-go" rel="noopener noreferrer" target="_blank" aria-label="源码" class="nav-link vp-hero-action default"><!---->源码<!----><!----></a></p></div></div></header><!--[--><div class="vp-highlight-wrapper" style=""><div class="vp-highlight-bg light" style="background-image:url(https://theme-hope-assets.vuejs.press/bg/3-light.svg);"></div><div class="vp-highlight-bg dark" style="background-image:url(https://theme-hope-assets.vuejs.press/bg/3-dark.svg);"></div><div class="vp-highlight"><!--[--><img class="vp-highlight-image" src="/obcsapi-go/assets/image/box.svg" alt="功能"><!----><!--]--><!--[--><div class="vp-highlight-info-wrapper"><div class="vp-highlight-info"><h2 class="vp-highlight-header">功能</h2><!----><ul class="vp-highlights"><li class="vp-highlight-item-wrapper"><div class="vp-highlight-item"><h3 class="vp-highlight-title"><!----><span>基于 Obsidian S3 存储， CouchDb ，本地存储和 WebDAV 的后端 API ,可借助 Obsidian 插件 Remotely-Save 插件，或者 Self-hosted LiveSync (ex:Obsidian-livesync) 插件 CouchDb 方式，保存消息到 Obsidian 库。或者支持本地文件夹的文本编辑器。</span></h3><!----></div></li></ul></div></div><!--]--></div></div><div class="vp-feature-wrapper"><div class="vp-feature-bg light" style="background-image:url(https://theme-hope-assets.vuejs.press/bg/2-light.svg);background-repeat:repeat;background-size:initial;"></div><div class="vp-feature-bg dark" style="background-image:url(https://theme-hope-assets.vuejs.press/bg/2-dark.svg);background-repeat:repeat;background-size:initial;"></div><div class="vp-feature" style=""><!--[--><!----><!----><!--]--><!--[--><h2 class="vp-feature-header">后端 API</h2><p class="vp-feature-description">给云存储中的文本文件添加 API ，保存消息到云存储</p><!--]--><div class="vp-features"><div class="vp-feature-item"><h3 class="vp-feature-title"><!----><span>网页</span></h3><p class="vp-feature-details">PWA 网页应用添加</p></div><div class="vp-feature-item"><h3 class="vp-feature-title"><!----><span>微信</span></h3><p class="vp-feature-details">微信测试号</p></div><div class="vp-feature-item"><h3 class="vp-feature-title"><!----><span>简悦</span></h3><p class="vp-feature-details">简悦 SimpRead Webook 裁剪网页文章</p></div><div class="vp-feature-item"><h3 class="vp-feature-title"><!----><span>FV 悬浮球</span></h3><p class="vp-feature-details">FV 悬浮球调用 API 添加图文</p></div><div class="vp-feature-item"><h3 class="vp-feature-title"><!----><span>静读天下</span></h3><p class="vp-feature-details">高亮标注添加</p></div><div class="vp-feature-item"><h3 class="vp-feature-title"><!----><span>其他</span></h3><p class="vp-feature-details">通用 API / Lua 脚本自定义处理逻辑添加</p></div></div></div></div><div class="vp-highlight-wrapper" style=""><div class="vp-highlight-bg light" style="background-image:url(https://theme-hope-assets.vuejs.press/bg/5-light.svg);"></div><div class="vp-highlight-bg dark" style="background-image:url(https://theme-hope-assets.vuejs.press/bg/5-dark.svg);"></div><div class="vp-highlight"><!--[--><img class="vp-highlight-image" src="/obcsapi-go/assets/image/layout.svg" alt="前端应用"><!----><!--]--><!--[--><div class="vp-highlight-info-wrapper"><div class="vp-highlight-info"><h2 class="vp-highlight-header">前端应用</h2><p class="vp-highlight-description">一个 PWA 应用。</p><ul class="vp-highlights"><li class="vp-highlight-item-wrapper"><div class="vp-highlight-item"><h3 class="vp-highlight-title"><!----><span>添加修改</span></h3><p class="vp-highlight-details">添加修改基础功能</p></div></li><li class="vp-highlight-item-wrapper"><div class="vp-highlight-item"><h3 class="vp-highlight-title"><!----><span>上传图片</span></h3><p class="vp-highlight-details">可以上传图片</p></div></li><li class="vp-highlight-item-wrapper"><div class="vp-highlight-item"><h3 class="vp-highlight-title"><!----><span>自定义表单</span></h3><p class="vp-highlight-details">通过 JSONSchema 定义表单，交给后端 Lua 脚本处理</p></div></li><li class="vp-highlight-item-wrapper"><div class="vp-highlight-item"><h3 class="vp-highlight-title"><!----><span>指令模式</span></h3><p class="vp-highlight-details">简易对话匹配 或 运行 Bash / Lua 脚本</p></div></li><li class="vp-highlight-item-wrapper"><div class="vp-highlight-item"><h3 class="vp-highlight-title"><!----><span>修改配置</span></h3><p class="vp-highlight-details">修改前后端配置</p></div></li><li class="vp-highlight-item-wrapper"><div class="vp-highlight-item"><h3 class="vp-highlight-title"><!----><span>深色模式</span></h3><p class="vp-highlight-details">可以自由切换浅色模式与深色模式</p></div></li></ul></div></div><!--]--></div></div><div class="vp-highlight-wrapper" style=""><div class="vp-highlight-bg light" style="background-image:url(https://theme-hope-assets.vuejs.press/bg/4-light.svg);"></div><div class="vp-highlight-bg dark" style="background-image:url(https://theme-hope-assets.vuejs.press/bg/4-dark.svg);"></div><div class="vp-highlight"><!--[--><img class="vp-highlight-image" src="/obcsapi-go/assets/image/advanced.svg" alt="高级"><!----><!--]--><!--[--><div class="vp-highlight-info-wrapper"><div class="vp-highlight-info"><h2 class="vp-highlight-header">高级</h2><p class="vp-highlight-description">高级自定义功能</p><ul class="vp-highlights"><li class="vp-highlight-item-wrapper"><div class="vp-highlight-item"><h3 class="vp-highlight-title"><!----><span>对话模式 Bash / Lua 脚本</span></h3><p class="vp-highlight-details">运行自定义命令</p></div></li><li class="vp-highlight-item-wrapper"><div class="vp-highlight-item"><h3 class="vp-highlight-title"><!----><span>自定义请求处理</span></h3><p class="vp-highlight-details">用户编写 Lua 脚本处理请求</p></div></li><li class="vp-highlight-item-wrapper"><div class="vp-highlight-item"><h3 class="vp-highlight-title"><!----><span>自定义定时任务</span></h3><p class="vp-highlight-details">用户编写 Lua 脚本处理定时任务</p></div></li><li class="vp-highlight-item-wrapper"><div class="vp-highlight-item"><h3 class="vp-highlight-title"><!----><span>自定义表单</span></h3><p class="vp-highlight-details">使用 JSONSchema 自定义表单，用户编写 Lua 脚本处理自定义表单</p></div></li></ul></div></div><!--]--></div></div><!--]--><!----><div class="theme-hope-content"></div><!----></main><!--]--><footer class="vp-footer-wrapper"><div class="vp-footer">使用 <a href="https://theme-hope.vuejs.press/zh/" target="_blank">VuePress Theme Hope</a> 主题 | MIT 协议, 版权所有 © 2023 <a href="https://www.ftls.xyz/" target="_blank" rel="noopener noreferrer">恐咖兵糖</a></div><!----></footer></div><!--]--><!--]--><!----><!--]--></div>
    <script type="module" src="/obcsapi-go/assets/app-Z7Ab_rlY.js" defer></script>
  </body>
</html>
